skpkg: migrate documentation, README, and public static files#283
skpkg: migrate documentation, README, and public static files#283sbillinge merged 12 commits intodiffpy:migrationfrom
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## migration #283 +/- ##
==========================================
Coverage 95.10% 95.10%
==========================================
Files 23 23
Lines 1123 1123
==========================================
Hits 1068 1068
Misses 55 55 🚀 New features to boost your workflow:
|
|
@sbillinge , it's ready for review. |
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
please bring over license.rst and index.rst from the old packages without changes. Then also address my comments. Thx
doc/source/index.rst
Outdated
| .. |title| replace:: diffpy.pdfgui documentation | ||
|
|
||
| diffpy.pdfgui - GUI for PDF simulation and structure refinement. | ||
| ``diffpy.pdfgui`` - Graphical user interface program for structure refinements to atomic pair distribution function. |
| | Last updated |today| | ||
| | Last updated |today|. | ||
|
|
||
| For users who do not have the expertise or necessity for command |
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
just a few more comments.
doc/source/getting-started.rst
Outdated
| @@ -0,0 +1,79 @@ | |||
| :tocdepth: -1 | |||
There was a problem hiding this comment.
this entire file needs to be deleted. There is pdfgui documentation so we don't need this stub. Also the skpkg logo
| @@ -0,0 +1,28 @@ | |||
| .. list-table:: 5 levels of reusing/sharing code | |||
There was a problem hiding this comment.
this example doc file also should be deleted
|
@sbillinge , it's ready for review. |
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
nearly there...I caught one last thing.
| @@ -0,0 +1,31 @@ | |||
| .. _example_package documentation: | |||
There was a problem hiding this comment.
@ycexiao sorry I missed this stub file too. This needs to be deleted.
|
@sbillinge , it's ready for review. |
2 participants
No description provided.